Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: documenting public API (fixes #431) #442

Merged
merged 3 commits into from
May 5, 2020
Merged

Docs: documenting public API (fixes #431) #442

merged 3 commits into from
May 5, 2020

Conversation

anikethsaha
Copy link
Member

@anikethsaha anikethsaha commented Apr 22, 2020 •
edited
Loading

fixes #431

  • Added docs for public apps.
    • added their description
    • added parameters (if any)
    • added example and output (as collapsible )
  • Separate section for options
  • Added script to sync the README.md from root to docs/ directory.
  • preview

@anikethsaha anikethsaha changed the title Docs: documenting public API (fix #431) Docs: documenting public API (fixes #431) Apr 22, 2020
kaicataldo
kaicataldo approved these changes May 5, 2020
View reviewed changes
Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is really great. Thanks for working on this!

@kaicataldo kaicataldo merged commit 6048bfe into eslint:master May 5, 2020
@anikethsaha anikethsaha deleted the docs-tokenize branch May 5, 2020 04:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kaicataldo kaicataldo kaicataldo approved these changes

@nzakas nzakas nzakas approved these changes

Assignees
No one assigned
Labels
triage
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document public API
3 participants
@anikethsaha @nzakas @kaicataldo